/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * This file is part of retabel.
 *
 * Copyright (c) 2011 by individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution
 * for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.retabel.persistence.entity.render;

import org.retabel.persistence.entity.document.DocumentConfiguration;

import javax.persistence.*;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;

/**
 * Entity to hold the content and metadata of rendered documents.
 * <p/>
 * <h3>Extra-Info</h3>
 * Created: 20:12 20.08.11
 *
 * @author Burt Parkers
 * @version 1.0
 */
@Entity
@NamedQueries({
    @NamedQuery(name = "RenderedDocument.findByDocumentIdentifier",
                query = "select renderedDocument from RenderedDocument renderedDocument where renderedDocument.documentIdentifier=?1")
})
public class RenderedDocument {

    /** The id field. */
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private int id;

    /** Unique document identifier to find and access it outside the system. */
    @Column(nullable = false, length = 50, unique = true)
    private String documentIdentifier;

    /** Created timestamp. */
    @Column(nullable = false)
    @Temporal(TemporalType.TIMESTAMP)
    private Date created;

    /** The aggregated document parts. */
    @OneToMany(cascade = {CascadeType.ALL})
    private Collection<RenderedDocumentPart> renderedDocumentParts;

    /** The associated configuration. */
    @OneToOne
    private DocumentConfiguration documentConfiguration;

    /** Initializes the Dates. */
    @PrePersist
    private void updateDates() {
        if (created == null) {
            Calendar calendar = Calendar.getInstance();
            created = new Date(calendar.getTimeInMillis());
        }
    }

    /**
	 * Returns the value for id.
	 *
	 * @return the id.
	 */
	public int getId() {
		return id;
	}

	/**
	 * Sets the value for id.
	 *
	 * @param id the id to set.
	 */
	public void setId(int id) {
		this.id = id;
	}

	/**
	 * Returns the value for documentIdentifier.
	 *
	 * @return the documentIdentifier.
	 */
	public String getDocumentIdentifier() {
		return documentIdentifier;
	}

	/**
	 * Sets the value for documentIdentifier.
	 *
	 * @param documentIdentifier the documentIdentifier to set.
	 */
	public void setDocumentIdentifier(String documentIdentifier) {
		this.documentIdentifier = documentIdentifier;
	}

	/**
	 * Returns the value for created.
	 *
	 * @return the created.
	 */
	public Date getCreated() {
		return created;
	}

	/**
	 * Sets the value for created.
	 *
	 * @param created the created to set.
	 */
	public void setCreated(Date created) {
		this.created = created;
	}

	/**
	 * Returns the value for renderedDocumentParts.
	 *
	 * @return the renderedDocumentParts.
	 */
	public Collection<RenderedDocumentPart> getRenderedDocumentParts() {
		return renderedDocumentParts;
	}

	/**
	 * Sets the value for renderedDocumentParts.
	 *
	 * @param renderedDocumentParts the renderedDocumentParts to set.
	 */
	public void setRenderedDocumentParts(Collection<RenderedDocumentPart> renderedDocumentParts) {
		this.renderedDocumentParts = renderedDocumentParts;
	}

	/**
	 * Returns the value for documentConfiguration.
	 *
	 * @return the documentConfiguration.
	 */
	public DocumentConfiguration getDocumentConfiguration() {
		return documentConfiguration;
	}

	/**
	 * Sets the value for documentConfiguration.
	 *
	 * @param documentConfiguration the documentConfiguration to set.
	 */
	public void setDocumentConfiguration(DocumentConfiguration documentConfiguration) {
		this.documentConfiguration = documentConfiguration;
	}
}
